Operator SDK开发简介

字数统计: 1.1k阅读时长: 5 min

 2020/10/15   Share

官方的github项目地址: https://github.com/operator-framework/operator-sdk

你可以基于Go/Ansible开发Opearator 。基于Go的典型工作流程如下：

使用SDK的CLI，创建一个新的Operator项目
添加CRD，并定义一个新的资源API
定义监控、调和（reconcile，通过适当的操作让资源接近期望状态）资源的控制器
使用SDK、controller-runtime API来开发调和逻辑
使用SDK CLI来构建、生成Operator的部署清单文件

##前提条件

dep version v0.5.0+.
git
go version v1.10+.
docker version 17.03+.
kubectl version v1.11.0+.
Access to a kubernetes v.1.11.0+ cluster.

安装SDK CLI

mkdir -p $GOPATH/src/github.com/operator-framework
cd $GOPATH/src/github.com/operator-framework
git clone https://github.com/operator-framework/operator-sdk
cd operator-sdk
git checkout master
make dep
make install

快速开始

###创建项目

# Create an app-operator project that defines the App CR.
# The command like this: cd $GOPATH/src/github.com/<your-github-repo>/
$ mkdir -p $GOPATH/src/github.com/example-inc/

# Create a new app-operator project
$ cd $GOPATH/src/github.com/example-inc/
# The command like this : operator-sdk new <operator-project-name> --api-version=<your-api-group>/<version> --kind=<custom-resource-kind>
$ operator-sdk new app-operator


$ cd app-operator

上述脚本执行后，会自动调用dep init创建项目，调用dep ensure下载依赖，并初始化Git仓库

operator-project-name：创建的项目的名称
your-api-group：Kubernetes 自定义 API 的组名，一般用域名
version：Kubernetes 自定义资源的 API 版本
custom-resource-kind：CRD 的名称

添加API

1	$ operator-sdk add api --api-version=app.example.com/v1alpha1 --kind=AppService

上述命令完成后，会在pkg/apis目录下自动生成一系列文件，类似于code-generator

添加控制器

1	$ operator-sdk add controller --api-version=app.example.com/v1alpha1 --kind=AppService

上述命令完成后，会在pkg/controller目录生成控制器源码

构建Operator镜像

1
2
3

# Build and push the app-operator image to a public registry such as quay.io
$ operator-sdk build quay.io/example/app-operator
$ docker push quay.io/example/app-operator

注意需要修改deploy/operator.yaml中的REPLACE_IMAGE为实际镜像名：

1	sed -i 's\|REPLACE_IMAGE\|quay.io/example/app-operator\|g' deploy/operator.yaml

在本地运行

在开发期间，一般在本地运行Operator，以便快速测试和调试

# 通过环境变量设置Operator名称
export OPERATOR_NAME=app-operator
# 启动Operator，会自动使用$HOME/.kube/config。你可以用--kubeconfig=指定kubeconfig
operator-sdk up local --namespace=default

部署

# Setup Service Account
$ kubectl create -f deploy/service_account.yaml
# Setup RBAC
$ kubectl create -f deploy/role.yaml
$ kubectl create -f deploy/role_binding.yaml
# Setup the CRD
$ kubectl create -f deploy/crds/app_v1alpha1_appservice_crd.yaml
# Deploy the app-operator
$ kubectl create -f deploy/operator.yaml

# Create an AppService CR
# The default controller will watch for AppService objects and create a pod for each CR
$ kubectl create -f deploy/crds/app_v1alpha1_appservice_cr.yaml

# Verify that a pod is created
$ kubectl get pod -l app=example-appservice
NAME                     READY     STATUS    RESTARTS   AGE
example-appservice-pod   1/1       Running   0          1m

# Cleanup
$ kubectl delete -f deploy/crds/app_v1alpha1_appservice_cr.yaml
$ kubectl delete -f deploy/operator.yaml
$ kubectl delete -f deploy/role.yaml
$ kubectl delete -f deploy/role_binding.yaml
$ kubectl delete -f deploy/service_account.yaml
$ kubectl delete -f deploy/crds/app_v1alpha1_appservice_crd.yaml

开发阶段完成后，建议使用Helm Chart打包封装

###项目录结构

基于operator-sdk生成的Operator项目，其目录结构如下

目录/文件	说明
cmd	manager/main.go为主函数，它： 1. 初始化一个新的Manager 2. 注册所有pkg/apis下定义的CR 3. 启动所有pkg/controllers下定义的控制器
pkg/apis	包含CRD的API，开发人员需要编辑pkg/apis/GROUP/VERSION/KIND_types.go文件，为资源添加必要的字段
pkg/controller	包含控制器的实现，开发人员需要编辑pkg/controller/KIND/KIND_controller.go，实现KIND资源的Reconcile逻辑
build	包含Dockerfile，以及构建Operator所需的脚本
deploy	YAML形式的K8S资源定义文件，用于注册CRD、创建RABC、Deployment等资源
Gopkg.*	Go Dep的清单文件
vendor	为了满足项目import需要的外部依赖的副本